Merge parameter data to preserve description in manually edited Openapi spec - #149
Merged
exoego merged 1 commit intoDec 1, 2023
Merged
Conversation
mercedesb
force-pushed
the
dont-overwrite-parameter-descriptions
branch
from
November 30, 2023 22:10
5cd3059 to
b83022e
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #149 +/- ##
==========================================
+ Coverage 96.68% 96.73% +0.05%
==========================================
Files 14 14
Lines 422 429 +7
Branches 94 95 +1
==========================================
+ Hits 408 415 +7
Misses 14 14 ☔ View full report in Codecov by Sentry. |
mercedesb
force-pushed
the
dont-overwrite-parameter-descriptions
branch
from
November 30, 2023 22:41
b123eba to
8e40280
Compare
mercedesb
changed the title
exoego
approved these changes
Dec 1, 2023
exoego
left a comment
exoego
left a comment
Owner
There was a problem hiding this comment.
Thanks.
IIUC, this PR is a bugfix.
The previous implementation fails to preserve manually-added properties (description for this case).
I confirmed that description is gone without your fix.
Nice catch.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves #144
In the issue comment, I saw that we expect to be able to add/edit parameter descriptions and have them be preserved.
From my testing, it looks like that's not happening.
This is a small change that should keep the unique behavior on parameter
nameandinwhile preservingdescriptionif someone manually added it to the generated properties.